Skip to content

in_opentelemetry: added five missing configuration option descriptions. Fixes #11191.#11192

Merged
patrick-stephens merged 1 commit intofluent:masterfrom
eschabell:erics_add_in_opentelemetry_config_descriptions
Nov 21, 2025
Merged

in_opentelemetry: added five missing configuration option descriptions. Fixes #11191.#11192
patrick-stephens merged 1 commit intofluent:masterfrom
eschabell:erics_add_in_opentelemetry_config_descriptions

Conversation

@eschabell
Copy link
Contributor

@eschabell eschabell commented Nov 21, 2025 •
edited by coderabbitai bot
Loading

in_opentelemetry: added five missing configuration option descriptions. Fixes #11191.

Enter [N/A] in the box, if an item is not applicable to your change.

Testing
NA

  • [N/A ] Attached Valgrind output that shows no leaks or memory corruption was found

If this is a change to packaging of containers or native binaries then please confirm it works for all targets.

  • [ N/A] Run local packaging test showing all targets (including any new ones) build.
  • [ N/A] Set ok-package-test label to test for all targets (requires maintainer to do).

Documentation

  • [N/A] Documentation required for this feature

N/A

Backporting

  • [N/A] Backport to latest stable release.

Fluent Bit is licensed under Apache 2.0, by submitting this pull request I understand that this code will be released under the terms of that license.

Summary by CodeRabbit

  • Documentation
    • Added comprehensive help descriptions for OpenTelemetry plugin configuration options. Users will now see helpful guidance for HTTP/2 protocol settings, buffer management parameters (including maximum size and chunk size settings), custom tag key options, and logging metadata configuration. These additions enhance clarity and ease of use during plugin configuration.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link

coderabbitai bot commented Nov 21, 2025 •
edited
Loading

Walkthrough

The OpenTelemetry input plugin configuration has been updated with five missing help text descriptions for its config options: enable_http2, buffer_max_size, buffer_chunk_size, tag_key, and logs_metadata_key. These descriptions provide users with guidance when viewing available plugin options.

Changes

Cohort / File(s) Summary
Configuration metadata enhancement
plugins/in_opentelemetry/opentelemetry.c		 Added help text descriptions to five config_map entries: enable_http2 ("Enable HTTP/2 protocol support"), buffer_max_size ("Maximum size of the HTTP request buffer"), buffer_chunk_size ("Size of each buffer chunk allocated for HTTP requests"), tag_key ("Record accessor key to use for generating tags"), and logs_metadata_key ("Key name to store OpenTelemetry logs metadata")

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Verify each description is accurate and matches the intended config option behavior
  • Confirm consistency with description style and formatting conventions used elsewhere in the codebase

Poem

🐰 Five fields were bare, no words to guide,
Now help text flows from inside,
HTTP/2, buffers, keys, metadata's call—
A rabbit's gift of clarity for all!

Pre-merge checks and finishing touches

✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and specifically describes the main change: adding five missing configuration option descriptions to the in_opentelemetry plugin, and references the related issue #11191.
Linked Issues check ✅ Passed The PR addresses all five missing configuration descriptions (http2, buffer_max_size, buffer_chunk_size, tag_key, logs_metadata_key) as specified in issue #11191.
Out of Scope Changes check ✅ Passed All changes are scoped to adding configuration option descriptions in the in_opentelemetry plugin; no unrelated modifications are present.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4f8c50b and 56e53b9.

📒 Files selected for processing (1)
  • plugins/in_opentelemetry/opentelemetry.c (3 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-11-21T06:23:29.750Z 
Learnt from: cosmo0920
Repo: fluent/fluent-bit PR: 11171
File: include/fluent-bit/flb_lib.h:52-53
Timestamp: 2025-11-21T06:23:29.750Z
Learning: In Fluent Bit core (fluent/fluent-bit repository), function descriptions/documentation are not required for newly added functions in header files.

Applied to files:

  • plugins/in_opentelemetry/opentelemetry.c
🔇 Additional comments (1)
plugins/in_opentelemetry/opentelemetry.c (1)

203-203: LGTM! All five missing configuration descriptions have been added.

The descriptions are clear, accurate, and consistent with the existing documentation style in the file. The implemented descriptions appropriately expand on the suggestions from issue #11191 by adding clarifying phrases (e.g., "for the OpenTelemetry receiver", "from incoming records", "in the record") that make them more helpful to users without changing their core meaning.

All objectives from the linked issue have been successfully addressed:

  • ✓ http2
  • ✓ buffer_max_size
  • ✓ buffer_chunk_size
  • ✓ tag_key
  • ✓ logs_metadata_key

Also applies to: 222-222, 228-228, 234-234, 255-255

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

  • Provide your own instructions using the high_level_summary_instructions setting.
  • Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
  • Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

  1. 📝 Description — Summarize the main change in 50–60 words, explaining what was done.
  2. 📓 References — List relevant issues, discussions, documentation, or related PRs.
  3. 📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.
  4. 📊 Contributor Summary — Include a Markdown table showing contributions:
    | Contributor | Lines Added | Lines Removed | Files Changed |
  5. ✔️ Additional Notes — Add any extra reviewer context.
    Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@eschabell eschabell mentioned this pull request Nov 21, 2025
Closed
@eschabell
Copy link
Contributor Author

eschabell commented Nov 21, 2025

Fluent Bit Docs update PR: fluent/fluent-bit-docs#2182

@patrick-stephens
Copy link
Contributor

patrick-stephens commented Nov 21, 2025

Good catch, probably should have been caught by the review - ideally the AI bot.
Can you backport as well?

@eschabell
Copy link
Contributor Author

eschabell commented Nov 21, 2025

@patrick-stephens see:

#11194
#11195

@patrick-stephens patrick-stephens merged commit 0e56bc2 into fluent:master Nov 21, 2025
58 checks passed
@eschabell eschabell deleted the erics_add_in_opentelemetry_config_descriptions branch November 25, 2025 08:22
@coderabbitai coderabbitai bot mentioned this pull request Dec 4, 2025
Merged
1 task
@BrewTestBot BrewTestBot mentioned this pull request Dec 18, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cosmo0920 cosmo0920 cosmo0920 approved these changes

@patrick-stephens patrick-stephens patrick-stephens approved these changes

@edsiper edsiper Awaiting requested review from edsiper edsiper is a code owner

Assignees

No one assigned

Labels

docs-required

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

OpenTelemetry Input Plugin - missing 5 descriptions in the options for this plugin

3 participants

@eschabell @patrick-stephens @cosmo0920